Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add a starter template #526

Merged
merged 41 commits into from
Apr 11, 2024
Merged

add a starter template #526

merged 41 commits into from
Apr 11, 2024

Conversation

erral
Copy link
Member

@erral erral commented Oct 30, 2022

With this starter template we can initialize the Plone site with some sane defaults. This sub-template will be used by cookiecutter-plone-starter

Right now it only sets the site title and configures the default languages.

See collective/cookiecutter-plone-starter#25 for reference.

@erral
Copy link
Member Author

erral commented Oct 30, 2022

@ericof @jensens if you think that more things should be added to the default template when creating a Plone site with cookiecutter-plone-starter, we will add them here.

@jensens
Copy link
Member

jensens commented Nov 1, 2022

I have no strong opinion here. Less is more IMO, so this looks fine.

@MrTango
Copy link
Contributor

MrTango commented Nov 4, 2022

If we have this in plonecli/bobtemplates.plone we should add docs and describe better what it does.
The name starter is rather generic.
It might be more clear when you use it from the starter template, but it could also be used inside plonecli directly.
Another option would be, that we deliver this sub-template via a new bobtemplates package which also does the registration for plonecli. That would be the better option, if this template is only useful for the starter-template.
Not sure if thats the case.

@erral
Copy link
Member Author

erral commented Nov 27, 2022

I have renamed the template to be plone_site_initialization I think the name is better that the starter one. We may add in the future more configuration items here.

The aim of this subtemplate is to be able to initialize a Plone site using an addon, this way, when installed, the addon can set the site title, available langues, or whatever. It's a kind of "policy product configuration", but I have never liked the "policy" name for this :/

@MrTango
Copy link
Contributor

MrTango commented Jan 25, 2023

@erral i mannaged to finally fix the build.
But i have a wish regarding the naming.
I like the plone_site_initialization, it says what it does.
But so far this is only the alias in plonecli.
We should rename the whole template as follows:

folder: /bobtemplate/site_initialization
global name in setup: plone_site_initialization
alias in plonecli: site_initialization

this way it's all clean from the start ;)

@erral
Copy link
Member Author

erral commented Jan 26, 2023

I have renamed everything to site_initialization :)

Copy link
Contributor

@MrTango MrTango left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, but the changes in setup.py look ood, please explain why we should write the string like this.

setup.py Outdated Show resolved Hide resolved
@erral
Copy link
Member Author

erral commented Apr 14, 2023

The strange strings were removed.

@erral erral requested review from ericof and MrTango October 3, 2023 08:06
@MrTango
Copy link
Contributor

MrTango commented Oct 3, 2023

the test setup, is broken here. I tried to fix it, but so far we still have some linting issues inside the generated addon tests.
I'm running out of time for the moment, this needs more investigation.

@erral
Copy link
Member Author

erral commented Oct 3, 2023

I will try to take care of this during the Conference sprint

@erral
Copy link
Member Author

erral commented Mar 22, 2024

@MrTango I finally removed the additions I made to include Python 3.11 in the test setup and the PR is green.

Including Python 3.11 should be a PR on itself if wanted.

@MrTango MrTango merged commit b8a90b0 into main Apr 11, 2024
6 checks passed
@MrTango MrTango deleted the erral-starter-subtemplate branch April 11, 2024 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants